| Server IP : 121.121.20.254 / Your IP : 216.73.216.202 Web Server : Microsoft-IIS/10.0 System : Windows NT WEB-SERVER 10.0 build 20348 (Windows Server 2022) AMD64 User : IUSR ( 0) PHP Version : 8.3.28 Disable Function : NONE MySQL : ON | cURL : ON | WGET : OFF | Perl : OFF | Python : OFF | Sudo : OFF | Pkexec : OFF Directory : C:/Program Files/LibreOffice/help/en-US/text/sbasic/python/ |
Upload File : |
<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<base href="../../../../">
<noscript><meta http-equiv="refresh" content="0; URL=../../../../en-US/noscript.html"></noscript>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Python Scripts Organization</title>
<link rel="shortcut icon" href="media/navigation/favicon.ico">
<link type="text/css" href="normalize.css" rel="Stylesheet">
<link type="text/css" href="prism.css" rel="Stylesheet">
<link type="text/css" href="default.css" rel="Stylesheet">
<script type="text/javascript" src="polyfills.js"></script><script type="text/javascript" src="languages.js"></script><script type="text/javascript" src="en-US/langnames.js"></script><script type="text/javascript" src="flexsearch.debug.js"></script><script type="text/javascript" src="prism.js"></script><script type="text/javascript" src="help2.js" defer></script><script type="text/javascript" src="a11y-toggle.js" defer></script><script type="text/javascript" src="paginathing.js" defer></script><script type="text/javascript" src="en-US/bookmarks.js" defer></script><script type="text/javascript" src="en-US/contents.js" defer></script><script type="text/javascript" src="help.js" defer></script><meta name="viewport" content="width=device-width,initial-scale=1">
</head>
<body>
<header id="TopLeftHeader"><a class="symbol" href="en-US/text/shared/05/new_help.html"><div></div></a><a class="logo" href="en-US/text/shared/05/new_help.html"><p dir="auto">LibreOffice 24.2 Help</p></a><div class="dropdowns"><div class="modules">
<button type="button" data-a11y-toggle="modules-nav" id="modules" aria-haspopup="true" aria-expanded="false" aria-controls="modules-nav">Module</button><nav id="modules-nav" hidden=""></nav>
</div></div></header><aside class="leftside"><input id="accordion-1" name="accordion-menu" type="checkbox"><label for="accordion-1" dir="auto">Contents</label><div id="Contents" class="contents-treeview"></div></aside><div id="SearchFrame"><div id="Bookmarks">
<input id="search-bar" type="search" class="search" placeholder="Search in bookmarks for chosen module" dir="auto"><div class="nav-container" tabindex="0"><nav class="index" dir="auto"></nav></div>
</div></div>
<div id="DisplayArea" itemprop="softwareHelp" itemscope="true" itemtype="http://schema.org/SoftwareApplication">
<a name="pythonlocation"></a>
<h1 id="hd_id391543358231021" dir="auto">
<a name="pythonlocations1"></a>Python Scripts Organization and Location</h1>
<p id="par_id481636114810038" class="paragraph" dir="auto">LibreOffice macros are grouped in module files, modules are usually grouped in library folders, and libraries are grouped in library containers although containers can contain modules too.</p>
<p id="par_id771543358231022" class="paragraph" dir="auto">A library is used as a major grouping for either an entire category of macros, or for an entire application. Modules usually split functionality, such as user interaction and calculations. Individual macros are subroutines and functions. The Figure below shows an example of the hierarchical structure of macro libraries in LibreOffice.</p>
<p id="par_id771636279690940" class="image" dir="auto"><img src="media/helpimg/sbasic/Library-Container.svg" class="genericimage" alt="Library Container diagram" style="width:304px;height:209px" itemprop="image" itemscope="true" itemtype="http://schema.org/ImageObject"></p>
<p id="par_id171636114787810" class="paragraph" dir="auto"><span class="emph">Figure:</span> Macro Library hierarchy</p>
<p id="par_id801636114790638" class="paragraph" dir="auto">The containers are accessible in all LibreOffice programs through the user interface. Go to <span class="menuitem">Tools > Macros > Organize Macros > Python</span>, to open the Python Macros dialog.</p>
<p id="par_id801636114808666" class="paragraph" dir="auto">Three library containers are shown in the Macro From list:</p>
<ol itemprop="HowTo" itemscope="true" itemtype="http://schema.org/HowToSection" dir="auto">
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/HowToStep" dir="auto">
<p id="par_id321636114854594" class="listitem" dir="auto"><span class="emph">My Macros:</span> personal macros available for the LibreOffice user</p>
</li>
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/HowToStep" dir="auto">
<p id="par_id471636114847530" class="listitem" dir="auto"><span class="emph">Application Macros:</span> system macros distributed with LibreOffice for every computer user</p>
</li>
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/HowToStep" dir="auto">
<p id="par_id191636114858218" class="listitem" dir="auto"><span class="emph">Document macros:</span> every document can contain macro libraries available in that document for all users</p>
</li>
</ol>
<h2 id="hd_id911544049584458" dir="auto">Python Script Locations</h2>
<p id="par_id121551089455774" class="paragraph" dir="auto">Refer to <a target="_top" href="en-US/text/sbasic/python/python_session.html">Getting Session Information</a> in order to get programmatic access to Python script locations.</p>
<h3 id="hd_id591544049572647" dir="auto">Application Macros</h3>
<p id="par_id261544049064421" class="paragraph" dir="auto">Existing macros in this location (container) were copied by the installation program and are available to every computer user, and any open document can access macros stored the container. You need administrative rights to store or edit macros here.</p>
<p id="par_id861544210028670" class="paragraph" dir="auto">The LibreOffice Macros container location in the file system depends on the operating system:</p>
<ul itemprop="Unordered" itemscope="true" itemtype="http://schema.org/ItemList" dir="auto">
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto">
<p id="par_id191544210072242" class="listitem" dir="auto">For <span class="emph">Windows</span>: <span class="literal">{Installation}\share\Scripts\python</span>.</p>
</li>
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto">
<p id="par_id61544210078654" class="listitem" dir="auto">For <span class="emph">Linux</span> and <span class="emph">macOS</span>: <span class="literal">{Installation}/share/Scripts/python</span>.</p>
</li>
</ul>
<h3 id="hd_id861544049692222" dir="auto">My Macros</h3>
<p id="par_id981544049055996" class="paragraph" dir="auto">This container is accessible only by the LibreOffice user. Any open document can access macros stored the container. Macros in this location are stored in the LibreOffice user profile.</p>
<p id="par_id341544210187846" class="paragraph" dir="auto">The My Macros container location is in the user space and depends on the operating system:</p>
<ul itemprop="Unordered" itemscope="true" itemtype="http://schema.org/ItemList" dir="auto">
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto">
<p id="par_id381544210213190" class="listitem" dir="auto">For <span class="emph">Windows</span>,<br><span class="literal">%APPDATA%\LibreOffice\4\user\Scripts\python</span>.</p>
</li>
<li itemprop="itemListElement" itemscope="true" itemtype="http://schema.org/ItemListUnordered" dir="auto">
<p id="par_id691544210219850" class="listitem" dir="auto">For <span class="emph">Linux</span> and <span class="emph">macOS</span>,<br><span class="literal">$HOME/.config/libreoffice/4/user/Scripts/python</span>.</p>
</li>
</ul>
<h3 id="hd_id101544049707712" dir="auto">Document macros</h3>
<p id="par_id31544049046497" class="paragraph" dir="auto">Document macros are embedded in the document and are accessible only when the document is open.</p>
<h2 id="hd_id171544049715310" dir="auto">Libraries, Modules and Macros</h2>
<p id="par_id181544209916707" class="paragraph" dir="auto">Python macros can be organized in libraries, modules and macros. Use the Macro Library hierarchy as a guide when creating or installing new macros in module files, new module files in library folders or new library folders in containers.</p>
<a name="relatedtopics"></a><div class="relatedtopics">
<p class="related" itemprop="mentions" dir="auto"><a name="related"></a><span class="emph">Related Topics</span>
</p>
<div class="relatedbody" itemprop="mentions">
<div class="embedded"><p class="embedded" dir="auto"><a target="_top" href="en-US/text/sbasic/python/python_session.html">Getting Session Information</a></p></div>
<div class="embedded"><p class="embedded" dir="auto"><a target="_top" href="en-US/text/sbasic/python/main0000.html">LibreOffice Python Scripts Help</a></p></div>
</div>
</div>
</div>
<div id="DonationFrame"></div>
<footer><div id="DEBUG" class="debug">
<h3 class="bug">Help content debug info:</h3>
<p dir="auto">This page is: <a href="https://opengrok.libreoffice.org/xref/help/source/text/sbasic/python/python_locations.xhp" target="_blank">/text/sbasic/python/python_locations.xhp</a></p>
<p dir="auto">Title is: Python Scripts Organization</p>
<p id="bm_module" dir="auto"></p>
<p id="bm_system" dir="auto"></p>
<p id="bm_HID" dir="auto"></p>
</div></footer>
</body>
</html>